Promotion JumpStart Guide

This JumpStart guide is designed to help you create a basic promotion setup without requiring you to read all of the documentation.

Prerequisites

  • The URLs of the source and target RunMyJobs instances.
  • The credentials and permissions necessary to create Remote System objects and Process Definitions in both systems. For cloud environments, technical user credentials are required.
  • A Process Definition to promote from the source instance to the target instance. This is referred to here as My_Process_Definition.

Conventions

In this scenario, we are promoting My_Process_Definition from the Development cloud environment to the Test cloud environment.

  • Development (source) system URL: https://dublin.runmyjobs.cloud/jumpstart/dev
  • Test (destination) system URL: https://dublin.runmyjobs.cloud/jumpstart/test

Note: In an on-premises environment with a URL of https://server1.example.com/redwood, the name of the source Remote System would be redwood.

Performing a Simple Promotion

Follow the steps below to perform a simple promotion.

  1. Create a destination Remote System object.

    1. In the Development environment, navigate to Promotion > Remote Systems.
    2. Click to create a new Remote System.
    3. Enter jumpstart_test into the Name field.
    4. Select Destination (or Both) from the Type dropdown list.
    5. Enter the URL of the Test environment in the Location (URL) field.
    6. Enter the Username and Password.
    7. Click Save & Close.
  2. Create a source Remote System object.
    1. In the Test environment, navigate to Promotion > Remote Systems.
    2. Click to create a new Remote System.
    3. Enter jumpstart_dev into the Name field.
    4. Select Source (or Both) from the Type dropdown list.
    5. Click Save & Close.
  3. Promote My_Process Definition from Development to Test.
    1. In the Development environment, navigate to Processes > Definitions and right-click My_Process_Definition.
    2. Choose Promote > Promote to System from the context menu and select jumpstart_test as the Remote System object.

Creating a Promotion Workflow with Review

This section describes how to create a promotion workflow from Development to Test that includes a confirmation step, where an Operator on the Test instance must respond to an Operator Message before the promotion is completed.

  1. In the Test environment, navigate to Promotion > Remote Systems.
  2. Create a Remote System of type Source named *. The asterisk makes this a "catch-all" Remote System, meaning that it will be used for any incoming promotion requests when RunMyJobs can't find a Remote System object that matches the source instance's name.
  3. Select System_Import_Archive_WithApproval from the Push Acceptor Process Definition dropdown list.
  4. Click Save & Close.
  5. In the Development environment, navigate to Processes > Definitions and right-click My_Process_Definition.
  6. Choose Promote > Promote to System from the context menu and select jumpstart_test as the Remote System object.
  7. In the Test environment, navigate to Monitoring > Operator Messages.
  8. Locate the Operator Message Should the car file that is attached to this Chain Definition be imported into this system?.
  9. In the Send Object column, choose XXXX - Raise an Operator Message (where XXXX is the ID of the process). A new tab displays for the System_OperatorMessage process.
  10. Choose Show in diagram from the context menu. A new tab displays with a diagram of the Chain.
  11. On the leftmost box in the diagram, click the Files icon and select the carin.car file. You can now unzip this file and inspect its contents.
  12. On the Operator Messages tab, right-click the Operator Message and choose Reply from the context menu.
  13. Indicate whether you want to import the CAR file by choosing Yes or No.

Enabling LockDown

LockDown is a setting that restricts imports to specific defined Remote System objects.

To enable LockDown:

  1. In the Test environment, navigate to Processes > Definitions.
  2. Locate System_Import_Settings and select Submit from its context menu.
  3. Choose Yes from the Lockdown dropdown list, then submit the Process Definition.

Verifying LockDown

To verify that LockDown is working:

  1. In the Test environment, rename the jumpstart_dev Remote System you created above to jumpstart_old.
  2. In the Test environment, rename the * Remote System you created above to invalid.
  3. Navigate to Promotion > Remote Systems, rename the Remote System * to *invalid.
  4. In the Development environment, navigate to Processes > Definitions and right-click My_Process_Definition.
  5. Choose Promote > Promote to System from the context menu and select jumpstart_test as the Remote System object.
  6. Right-click the System_Promote Process Definition and choose Monitor Related Processes from the context menu.
  7. Note that the process has reached Completed status. Even though Lockdown is enabled in the Test environment, the promotion is considered complete in the Development environment.
  8. In the Test environment, navigate to Monitoring > Processes and choose Custom Maintenance (Background) Processes from the Filter dropdown list.
  9. Note that the Import definitions from: System_XXXXX_XXXXXXX.car process has reached Error status.
  10. Inspect the process' stderr.log file. Note the exception java.lang.RuntimeException: Lockdown is enabled. This indicates that the import of the CAR file was not completed.